Night Owl 6

home *** CD-ROM | disk | FTP | other *** search

/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 033a / rwdir21.zip / RWDIR.DOC < prev next >

Wrap

Text File | 1991-11-01 | 31KB | 689 lines

RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility TABLE OF CONTENTS Page ----------------- Description and Features of RWDIR ............................... 1 Installation of RWDIR ........................................... 2 Running RWDIR ................................................... 3 Configuration Options ........................................... 4 Sample MENU ..................................................... 5 Sample Dir HEADER ............................................... 6 Configuration Commands .......................................... 7 Colourizing Menu's .............................................. 9 Colour KEYWORDS ................................................. 11 Shareware Notice ................................................ 12 Registration Form ............................................... 13 Upgrading from Previous Versions ................................ 14 RWDIR Support BBS: Richware ShareWare PCBoard Elgin, Illinois (708) 697 - 1606 (V.32bis/N81/Public Access) (708) 695 - 1613 (HST/Dual/N81/Private for subscribers and registered owners of any "RW" programs) All Rights Reserved. (c)opyright IDS Inc. Page 1 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility Initial Release: March 1 1991 Original Version: 1.2 (c)opyrighted By: IDS Schaumburg, IL Description ----------- This package referred to as RWDir contains two (2) executable programs: 1) RWSETUP.EXE (RWDir Install and Config Menu) 2) RWCONFIG.EXE (Creates the .CFG files for use by RWDir) 3) RWCOLORS.EXE (a WhatYouSeeIsWhatYouGet Color Editor) 4) RWINCLUD.EXE (Utility to insert the PCBoard %FileSpecs in DIRs) 2) RWDIRxx.EXE (creates Directory headers and/or File Menu's) ^^ the version number RWDir is a utility program designed to create attractive and informative File-Directory headers and/or File-Menu's for PCBoard(tm) BBS systems. It will tally # of Files and total Bytes in both the headers and menu's. It was written by a Sysop who was tired of using unreliable and inflexible alternatives currently available. Features -------- RWDir automatically configures itself! No longer is it required for the Sysop to manually configure and reconfigure the header program to relect the actual setup in use on the BBS system. RWSETUP reads (never writes) the PCBoard(tm) CNAMES and .LST files to identify which Conference Areas contain File(s) Directories, and is smart enough to know when they are the same as Main Board (Conference 0) Directories in order to avoid redundant processing of the same Directories! Briefly, RWDir features include: -Automatically Configures itself! -Optional BACKUP of all Directories prior to modification -Displays # of Files and total Bytes in Both the Headers and Menu's -Can create Menus (Bulletins?) without modifying the Directories. -SYSOP Defined COLORS can be defined for the Menus -and- Headers on a conference-by-conference basis -Allows the insertion of User-Defined lines inside either/both the Headers and/or Menus (Such as the PCBoard "@" variables), And you can specify Subtotal lines in your Menus too! -Use's PCB 14.5a %Filespec for fast and uncluttered operation! ■ SHARE Compatible. -Is SAFE, RELIABLE, Fast! and ACCURATE! Page 2 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility Installation ------------ Installation of RWDir has been enhanced so that you may easily setup and RUN RWDir without affecting your current PCBoard Directories. This allows you the oppertunity to 'PreView' the Output produced by RWDir and decide if you like it enough to implement it...It works out so good that we decided to have everyone follow this method for Installing the product. HENCE; you will find a file in this archive called INSTALL.DOC - - - - - - - - - - - - - - - - - - - - - - - - - -============> which describes the process of 'INSTALL' and 'IMPLEMENT' clearly. The entire process shouldnt take you more than 3 to 5 minutes. Really! The remainder of this documentation should be read after you decide to implement RWDir! It explains its operation and shows how you can take advantage of all of its (heretofor not explained) Added Features! Page 3 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility Running RWDir! -------------- The RWDir program uses Command-Line parameters! Some are REQUIRED, others are OPTIONAL! The Syntax for running RWDIRxx.EXE is: RWDIR20 CONFxxx.CFG /B /M /T ^^^^^^^^ these are OPTIONAL The first parameter is REQUIRED! This is the name of the Configuration file that the program will use. (Created by RWSETUP). The xxx in the filename refers to the Conference Number that the file refers to; keep in mind that the "Main Board" is always refered to as CONF000.CFG. To learn more about what the CONFxxx.CFG contains, and how you might want to modify it, read the section titled CONFIGURATION OPTIONS later in this documentation. The /B /M /T parameters are OPTIONAL, and may be used in any order and combination- They will NOT conflict with each other in any combination! /B requests the RWDIRxx.EXE program create BACKUPS of ALL Directories which are to be processed. Before a NEW Directory is written, the original will be copied to a file with the extention ".BAK" added to the Directory's original name. (C:\PCB\GEN\DIR01 will be Backed up to C:\PCB\GEN\DIR01.BAK) Since Version 2.x no longer writes to Directories, THIS ISNT NEEDED ANYMORE... /M instructs RWDIRxx.EXE to create Menu's ONLY. Normally, the program would create new Directories AND a new Menu; the /M allows you to create a Menu WITHOUT creating new Directories. This can be useful for creating a Bulletin or other file which displays a report of all your File(s) directories but wont waste time processing new Directories. For example, you may want to include this "Menu" with your downloadable listing that you make available for your users (PCBFILES.LST). /T tells the program that you are requesting a TEST RUN. A test run will allow you to create NEW Directories without modifying your current ones so that you can see what RWDIR output looks like before placing the program into production (Mainframers phrase!). ALL output Directories and Menu's will be placed inside the same location(s) as your original files, but will have ".NEW" as an extention. You can then Browse them BEFORE committing your system to RWDIR. If you like what you see you can remove the /T and re-run the program. (More about this in INSTALL.DOC) Page 4 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility CONFIGURATION OPTIONS --------------------- As you should already be aware, the RWDir program requires the use of a Configuration file. It may have been created by the RWSETUP.EXE program if you are following the normal installation procedure(s) as defined in the documentation. There are a few neat little features that you may implement inside the CFG file(s) that allow you to customize the appearance of the output. In *my* directories, I like to have the screen cleared before displaying the Directories and Menu's to the caller; this can be accomplished by telling RWDir to insert a PCBoard(tm) variable @CLS@ in the file(s). Also, I provide a menu to my users that shows ALL File Directories available accross the ENTIRE BBS (All Conferences). These things can be accomplished by RWDir by modifying the CFG file(s). Before explaining the modifications you can make to the CFG file(s), we will explain what each line inside them contain. example: CONF000.CFG RichWare ShareWare BBS < BBS Name from RWSETUP C:\PCB\GEN\MAIN,C:\RWDIR\ < Location of File MENU ^^^^^^^^^^------------> ,Location of HEADERS 1,C:\PCB\GEN\DIR01,DOS Utilities < Directory information 2,C:\PCB\GEN\DIR02,DISK Utilities Dir # 3,C:\PCB\GEN\DIR03,Graphics Dir location 4,C:\PCB\GEN\DIR04,Communications Dir description 5,C:\PCB\GEN\DIR05,Miscellaneous 6,C:\PCB\GEN\DIR06,Text Files (All Directory info 7,C:\PCB\GEN\DIR07,Sound is Automatically 8,C:\PCB\GEN\DIR08,Word Processing retrieved for you 9,C:\PCB\GEN\DIR09,Novelties from the CNAMES and 10,C:\PCB\GEN\DIR10,Unused .LST files by RWSETUP) 11,C:\PCB\GEN\DIR11,Pics n' Programs 12,C:\PCB\GEN\DIR12,Printer Utilities 13,C:\PCB\GEN\UPLOADS,Main Board UPLOADS All of the above information is extracted from CNAMES and the .LST files except for line #1 which is the BBS Name you entered in the RWSETUP program. Starting with Line three (3), and all subsequent lines, will be the info related to the Directory structure of the associated CONFerence Area. Page 5 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility CONFIGURATION OPTIONS Continued... ---------------------------------- The previous example of a typical CONF000.CFG file (mine!) would produce a MENU (C:\PCB\GEN\MAIN) and 13 Directories with headers. You should be aware that ALL the information contained in Lines 3 and on is retrieved from the CNAMES and .LST files! If you Dont have Descriptions after the second comma in each line it is because you have not entered any descriptions in PCBSETUP when you setup the Directories! (See your PCBoard(tm) manual!!) The resulting MENU from the above would look something like this: ╒═════════════════════════════════════════════════════════════════════════════╕ │ RichWare ShareWare BBS RWdir 1.0 (c)IDS │ ╞══════╤══════════════════════════════════╤══════════════╤════════════════════╡ │ Dir #│ Description │ Files │ Bytes │ ╘══════╧══════════════════════════════════╧══════════════╧════════════════════╛ 1. DOS Utilities 339 18,782,923 2. Disk Utilities 238 11,770,495 3. Graphics 143 9,419,123 4. Communications 175 11,348,350 5. Miscellaneous 144 12,598,291 6. Ascii Text 75 3,382,164 7. Sound Files 61 2,035,452 8. Word Processing 96 8,922,117 9. Novelties 133 6,402,317 10. Unused 0 0 11. Pics n' Programs 209 12,996,577 12. Printer Utilities 157 9,492,744 13. Main Board UPLOADS 67 5,313,529 ┌────────────────────────────────────────────────────────────────────┐ │ Totals 1,837 112,464,082 │ └────────────────────────────────────────────────────────────────────┘ The next page is an example of what the HEADER will look like on top of the Directories... Page 6 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility ╒════════════════════════════════════════════════════════════════════════════╕ │ RichWare ShareWare BBS RWdir 1.0 (c)IDS │ ╞════════╤═══════════════════════════════════════════════════════════════════╡ │ Dir 1 │ DOS Utilities │ ├────────┴───────────────┬────────────────────┬──────────────────────────────┤ │ # of Files: 339 │ Byte 18,782,923 │ Updated:02/28/91 @ 12:16 PM │ ├────────────┬────────┬──┴──────┬─────────────┴──────────────────────────────┤ │ Filename │ Size │ Date │ Description │ └────────────┴────────┴─────────┴────────────────────────────────────────────┘ 101TEMP.ZIP 1468 10-10-89 Templates for the enhanced keyboard (101 | key) 22DISK.ZIP 171242 10-10-89 Execute CP/M 2.2 programs on MS-DOS 22NCE126.ZIP 75593 07-13-90 CP/M 2.2 Emulator - use CP/M 2.2 disks | on your IBM (or clone) PC Page 7 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility CONFIGURATION OPTIONS Continued... ---------------------------------- There are a few commands you may issue from inside the CFG file that allow you to add (insert) information into both the HEADERS and MENUS; each of these commands always begin with a semi-colon (;). These ; commands can appear anywhere AFTER the second line in the CFG! They may be used more than once, and in any combination without conflict. ;H Header line insertion. ---------------------- Any characters found after a ;H will be inserted on the TOP of all subsequent Headers. This is how I get the @CLS@ into all my Directories so that PCBoard(tm) will Clear the screen prior to displaying it to the caller. You may enter ANYTHING you wish after the ;H and it will go to the top of all Headers written from that point on...A ;H record with nothing else on it instructs RWDir to write NOTHING on top of all subsequent headers created. (This is how you would cancel a previous ;H command). Example => ;H @CLS@ ;M Menu line insertion. ---------------------- You can insert a line into the Menu listing too! Any characters found after a ;M will be immediately printed in the Menu. If the remainder of the space after ;M are blank, no action is taken. Example => ;M @FIRST@, The following Dirs are located in Conferences Dave, The following Dirs are located in Conferences ;S SUBTOTAL insertion (Menu) ------------------------- This ;S instructs RWDir to print a SubTotal line of all Files and Bytes since the last subtotal, or beginning of the Menu File. Handy for those of us that display Main Board AND Conference Directories from the same Menu! Used in Combination with the ;M, you can create Titles for Grouping Directories, and even Provide SubTotals for them! ;B BLANK LINE insertion. (Menu) ----------------------------- Immediately prints a single BLANK LINE in the MENU. Useful after ;M or ;S lines! Example: ;M @FIRST@, The following Dirs are located in Conferences ;B Dave, The following Dirs are located in Conferences 3. Graphics 143 9,419,123 Page 8 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility CONFIGURATION OPTIONS Continued... ---------------------------------- Another alteration that you may employ inside the CFG file(s) is the ability to specify the Directory Number that you want displayed in the Menu. Its most useful for the ommission of a Directory Number in a menu when the directory itself is not available from the Conference-Area from where the Caller is viewing the Files Menu. By making a Directory Number in the CFG file(s) a ZERO (0), RWDir will print a BLANK Dir Number in the Menu. The Sample CFG file(s) provided will Demonstrate this. Confused? Sometimes, documentation cannot describe well enough what all the features are useful for. Running the program(s) through trial and error frequently clears a lot of this up. With the /T CommandLine Parameter in RWDir you can run it as many times as you wish without affecting your original Directories! RWDir was written using Microsoft BASIC Proffessional Development System, Version 7.1. RWDIR traps MOST errors, such as when your Disk becomes too Full and other such anomalies (sp). It will always attempt the safest shutdown preventing any loss of data whenever possible. Page 9 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility COLOURING MENUS --------------- New in RWDir13 is the ability to Colorize the Menus. This is accomplished through the use of Color-Files (CONFxxx.COL) for Conference-Specific colours, and/or RWDIR.COL which is the default colour file if no specific file is found in the 'Current Directory' while RWDir is Running. The color files "(.COL)" implement the PCBoard(tm) "@X" color-Codes. The actual colours each code defines can be found on Page 257 of your PCBoard 14.5 (tm) Manual. .COL file(s) MUST be located in the CURRENT DOS DIRECTORY from where you executed RWDIR! If neither color file can be found (CONFxxx.COL or RWDIR.COL) in the CURRENT DIRECTORY where you are executing RWDIR20 from, the colours in your MENU'S will be PLAIN WHITE on PLAIN BLACK! (We didnt feel you would appreciate having to include yet MORE DOS Environment Variables for yet another program!) Lets now look at HOW to define Colours for our MENU's... First, we have gone beyond a 'Simple' one or two colour approach whereby everything in the screen is the same colour. The MENU's are written out in 'COMPONENTS'; or 'Parts of a Whole'. This allows us the ability to use many colours and make the MENU a personal 'Work of Art'! All the 'Components' or 'Parts' as defined on the proceeding page can have their own FOREGROUND *and* BACKGROUND colours! Each Menu component ('Part') is assigned a name. You assign the Foreground and Background colours to these 'Names' or 'KEYWORDS' inside the .COL color file(s). Page 10 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility COLOURING MENUS Cont'd ... -------------------------- COLOR FILE USED BY RWDIR HEADER PROGRAM 2.0 OR ABOVE ---------------------------------------------------- KEYWORDS=@Xnn FREE FORM TEXT (YOUR NOTES, WHATEVER) ---------------- ----------------------------------------------- CLEAR CLEAR SCREEN BEFORE DISPLAY OF MENU (@CLS@) BOXTOP=@X14 MENU BOX IS RED-ON-BLUE (Also used for HEADER BOX!) BBSNAME=@X4B BBS NAME IS BRIGHT-CYAN-ON-RED BOXTITLES=@X78 TITLES IN BOX ARE BLACK-ON-WHITE (Also used in HEADER Titles!) DIRNUMBER=@X0A DIR NUMBERS ARE BRIGHT-GREEN-ON-BLACK DESCRIPTION=@X0B DESCRIPTIONS ARE BRIGHT-CYAN-ON-BLACK FILES=@X0E # OF FILES ARE YELLOW-ON-BLACK BYTES=@X0F # OF BYTES ARE BRIGHT-WHITE-ON-BLACK BOXBOTTOM=@X0C BOTTOM BOX (TOTALS) IS BRIGHT-RED-ON-BLACK TOTALS=@X1F TOTALS LINE IS BRIGHT-WHITE-ON-BLUE ;S=@X06 SUBTOTALS ARE YELLOW-ON-BLACK ;M=@X0D MENU MESSAGES ARE BRIGHT-MAGNETA-ON-BLACK The above is an example of the RWDIR.COL file provided with this archive. Please, see Page 257 of your PCBoard(tm) Manual for an explanation of the "@X.." codes! We wont attempt to explain them here! If you require different colors for different Conference areas, create a file called CONFxxx.COL {where xxx = the Conference Number 000-999}. This is most easily accomplished by using the supplied COLORIZE program from the RWSetup Menu! When RWDir executes, it looks for Specific Conference COLor files; if found, it will use those colors. If the CONFxxx.COL is NOT FOUND at run time, RWDir will attempt to load the Default Color File "RWDIR.COL" automatically. Page 11 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility KEYWORD Explanation -------- ------------------------------------------------------------------- CLEAR Instructs RWDIR20 to insert a "@CLS@" on TOP of the MENU file so that the Caller's screen will be CLEARED before display of the Menu. Note that CLEAR will be FORCED by RWDir if ANY of the KEYWORDS use a BACKGROUND COLOUR other than BLACK (0). BOXTOP= The MENU produced by RWDir uses a BOX, or OUTLINE to envelop the data in the Menu headings. The colour(s) specified for this keyword will result in in colorization of JUST THE BOX CHARACTERS themselves; NOT 'Everything inside it' !. BBSNAME= This is the BBS Name, or 'TITLE' as you Entered in RWSETUP. It is whats in Line #1 of every CONFxxx.CFG. Up to 59 bytes are defined in the unregistered version due to the Copyright notice. BOXTITLES= Are the " Dir #', ' Description ', ' Files ', and ' Bytes ' which serve as Titles to the data below the Menu Box. DIRNUMBER= The actual Directory Number printed under the ' Dir #' title in the Menu Box above it. DESCRIPTION= The actual Directory Description printed under the ' Description ' title in the Menu Box above it. FILES= The Files-Digits as counted by RWDir which appear in the Menu under the ' Files ' Title of the Menu Box. BYTES= The Bytes-Digits as calculated by RWDir which appear in the Menu under the ' Bytes ' Title of the Menu Box. BOXBOTTOM= The Outer BOX parts of the Totals located at the End of the Menu. (avoid BackGround Colours on this one!) TOTALS= The Totals-Digits inside the Boxottom at the end of the Menu. ;S= Any 'Subtotal Lines' that would be inserted into the Menu(s) as the result of using ";S" commands in your .CFG file(s). ;M= Any 'Message Lines' that would be inserted into the Menu(s) as the result of using ";M" commands in your .CFG file(s). BOXCHAR Like "CLEAR", this Keyword does NOT take a color-code! This Keyword, when present, instructs RWDir to use a BOXTOP made up of ONLY BACKGROUND COLOURS (as specified in BOXTOP). This Means there will be NO LINES as part of the BOX; just the BACKGROUND Colour specified in BOXTOP= (If your BOXTOP background colour is 0 (ZERO), then The Box will NOT APPEAR AT ALL. Try it! Page 12 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility ----------------------------------------------------------------------------- ShareWare Notice / License to Use ----------------------------------------------------------------------------- This utility program and all associated files, samples, and information are Copyrighted by Information Delivery Systems Incorporated (IDS) of Illinois; all items comprising the RWDIR utility are the sole property of IDS. As "ShareWare" you are granted a license to use RWDir for a period of 60 days as an Evaluation Period. If after 60 days you continue to use this utility you are expected to pay for it. (Registration). The cost of Registration for use beyond 60 days is only Twenty Bucks ($20) U.S funds Only. You may Download the REGISTERED VERSION of RWDir from our software support BBS "Richware ShareWare" after we recieve your payment. The REGISTERED VERSION will not place the "(c) IDS" Notice in your Directory or Menu file(s). In any such case, IDS will remain the owner of the program(s) and other files which comprise the RWDIR utility- you may not alter the program(s) in any way, or otherwise tamper with its operation. IDS disclaims any responsibility for the performance of any component of RWDIR by its use, or your inability to use; including any lost profits from any such use or misuse. IDS is an Illinois corporation doing business as a Software Development company RWDIR is NOT Public Domain software! We hope you enjoy using RWDir ! (Please REGISTER!) Page 13 =========================================================================== RWDIR REGISTRATION REQUEST =========================================================================== Enclose $20 (Personal/Business Checks, Money Orders, DRAWN ON US BANKS, made Payable to: ---------^^------- Information Delivery Systems -IDS PO BOX 309 ITASCA, IL 60143-0309 ** Add $5.00 for Laser Printed/Bound Manual and programs sent to you on Disk (Specify size/type preferred) ** REGISTERED TO: ______________________________________________ (your name, BBS Name or company name) Name to use for the Support BBS Signon: ________________ ________________________ _________ First Last Password Address: _____________________________________________________ ____________________________ PHONE (Voice) _________ Upon reciept of your payment, the above Name (First/Last/Password) will be granted access to the Support BBS and sufficient security appropriated to allow you to Download the Current REGISTERED VERSION of RWDIR. Instructions will be displayed to you when you call. *Note: Orders from Outside the US take considerably Longer time to process! Be SURE to send payment in US FUNDS!! Thank you for supporting the Shareware Concept! Amount Enclosed: $ _________ (U.S Funds ONLY!) Date: _____________ ___________________________________ Signature Comments: ------------------------------------------------------------------ Page 14 RWDir 2.0 PCBoard (tm) Directory Heads/Menu Utility ----------------------------------------------------------------------------- UPGRADING TO VERSION 2.0 from 1.3 ----------------------------------------------------------------------------- Registered users: See NOTE at bottom of Page!!! 11/01/91 The CONFxxx.CFG Files have Changed! The HEADS.BAT also has changed! If you are upgrading from version 1.3 or older, you MUST follow these instructions or the program(s) will NOT function! Backup your entire \RWDIR\ Subdirectory; then Delete EVERYTHING in it. UnZip the Contents of RWDIRxx.ZIP into \RWDIR\. Then just simply follow the INSTALL.DOC instructions. Optionally, you may just wish to start a New SubDirectory like; \RWDIR20\ and Install it and run it from there. You STILL NEED to follow INSTALL.DOC !! ** Note to PREVIOUSLY REGISTERED USERS: Starting with Version 2.0 we have implemented a "KEY" File method for Registering RWDir! The RWCNFxx.ZIP is distributed with the SHAREWARE KEY FILE included! To obtain your REGISTERED KEY File, call the BBS and Download it. (FREE; Subject to Note below) Want RWDir programs -AND- the Registered KEY file sent to you on Disk? Use the Order Form and include $5.00 for the cost of the diskette and Postage. (Outside the U.S or Canada, include $10 in U.S Funds to cover the added shipping costs). * Note: You MUST upgrade BEFORE FEBRUARY 1st, 1992 or you will incur an additional upgrade cost!! After Feb 1, 1992 RWDir Version 1.3 and earlier versions will No Longer be supported! (Shareware -or- Registered)